Configurar API de integración
|
|
Prerrequisitos
- SoftExpert Copilot como parte de las soluciones adquiridas por la organización.
- Ambiente SoftExpert Suite hospedado en la nube.
- Credencial previamente generada para utilizar la API Google v2 o v3.
- Acceso al menú Configuración > Central de integraciones (COP010).
Introducción
La Central de integraciones de Copilot cuenta con la pestaña API de integración, que proporciona las opciones con las que se puede integrar SoftExpert Suite, como Google, Amazon, Zenvia, Twilio y Azure AI Document Intelligence.
Además de estas APIs, SoftExpert Suite ofrece su propia API, denominada SoftExpert Suite, que proporciona servicios equivalentes a los de las API externas, con la ventaja de que no requiere la contratación de proveedores tercerizados.
Por medio de la pestaña API de integración, también es posible validar la conexión con las API disponibles en SoftExpert Copilot.
En este artículo, será presentado el procedimiento para configurar y validar las API de integración.
Configurar API de integración
1. Para configurar una API de integración, acceda al menú Configuración > Central de integraciones (COP010).
2. En la pestaña API de integración, se muestran las API ya configuradas en el sistema, y la API SoftExpert Suite viene registrada por defecto.
3. Haga clic en el botón 
de la barra de herramientas lateral para agregar una nueva API de integración.
4. En la pantalla que se abrirá, llene los siguientes campos:
Para utilizar la API Google v2 o v3, es necesario generar previamente la credencial.
-
API: seleccione la API deseada entre las opciones disponibles:
- Google v2: utilizada para la traducción automática de texto.
- Google v3: utilizada para la traducción automática de textos y archivos.
- Amazon AWS v3: utilizada para la traducción automática de texto.
- Zenvia: utilizada para el envío de mensajes automáticos vía SMS y WhatsApp.
- Twilio: utilizada para el envío de mensajes automáticos vía SMS y WhatsApp.
- Azure AI Document Intelligence: utilizada para la extracción de datos de documentos.
- Título: ingrese un identificador para la API.
- Campos específicos: dependiendo de la API seleccionada, el sistema solicitará información adicional. Complete los campos según los datos proporcionados por la respectiva plataforma de integración.
- Título: informe un título.
- Campos específicos: cada opción de API solicita determinados campos. Llénelos según los datos proporcionados por las plataformas de integración.
5. Una vez efectuado el llenado, haga clic en el botón 
para concluir el registro de la API.
6. La API se mostrará en la lista.
Cuando se utiliza, la API mostrará un icono de verificación 
que indica que está en uso.
Si es necesario editar algún dato de la API, como las credenciales, seleccione la API deseada y haga clic en Modificar.
Para eliminar una API, seleccione la opción correspondiente y haga clic en Excluir. Sin embargo, solo se permitirá la eliminación si la API no está en uso.
Validar API de integración
1. Para validar una API, seleccione la API deseada y haga clic en el botón 
.
2. En la pantalla que se abrirá, haga clic en el botón Validar API.
3. Al hacer clic en este botón, el sistema verificará que la API sea accesible y esté lista para ser utilizada por SoftExpert Copilot, garantizando una integración exitosa.
Conclusión
Con las API de integración correctamente configuradas y validadas, es posible configurar las API específicas de traducción, notificación e IDP.